// 版权所有2009 Go作者。保留所有权利。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// 包tls部分实现了RFC 5246中规定的tls 1.2、RFC 8446中规定的
// 和tls 1.3。
package tls

// BUG（agl）：crypto/tls软件包仅针对CBC模式加密的幸运13攻击，以及仅针对SHA1 
// 变体，实施了一些对抗措施。看见http:
// https:

import (
	"bytes"
	"context"
	"crypto"
	"crypto/ecdsa"
	"crypto/ed25519"
	"crypto/rsa"
	"crypto/x509"
	"encoding/pem"
	"errors"
	"fmt"
	"net"
	"os"
	"strings"
)

// 服务器返回一个新的TLS服务器端连接
// 使用conn作为底层传输。
// 配置必须为非零，并且必须包含
// 至少一个证书，否则设置GetCertificate。
func Server(conn net.Conn, config *Config) *Conn {
	c := &Conn{
		conn:   conn,
		config: config,
	}
	c.handshakeFn = c.serverHandshake
	return c
}

// 客户端返回一个新的TLS客户端连接
// 使用conn作为底层传输。
// 配置不能为零：用户必须在配置中设置ServerName或
// 不安全的SkipVerify。
func Client(conn net.Conn, config *Config) *Conn {
	c := &Conn{
		conn:     conn,
		config:   config,
		isClient: true,
	}
	c.handshakeFn = c.clientHandshake
	return c
}

// 侦听器为TLS连接实现网络侦听器（net.listener）。
type listener struct {
	net.Listener
	config *Config
}

// 接受等待并返回下一个传入的TLS连接。
// 返回的连接类型为*Conn。
func (l *listener) Accept() (net.Conn, error) {
	c, err := l.Listener.Accept()
	if err != nil {
		return nil, err
	}
	return Server(c, l.config), nil
}

// 新建侦听器创建一个侦听器，该侦听器接受来自内部
// 侦听器的连接，并将每个连接包装到服务器。
// 配置必须为非零，并且必须包含
// 至少一个证书，否则设置GetCertificate。
func NewListener(inner net.Listener, config *Config) net.Listener {
	l := new(listener)
	l.Listener = inner
	l.config = config
	return l
}

// Listen创建一个TLS侦听器，该侦听器接受
// 使用net的给定网络地址上的连接。听
// 配置必须为非零，并且必须包含
// 至少一个证书，否则设置GetCertificate。
func Listen(network, laddr string, config *Config) (net.Listener, error) {
	if config == nil || len(config.Certificates) == 0 &&
		config.GetCertificate == nil && config.GetConfigForClient == nil {
		return nil, errors.New("tls: neither Certificates, GetCertificate, nor GetConfigForClient set in Config")
	}
	l, err := net.Listen(network, laddr)
	if err != nil {
		return nil, err
	}
	return NewListener(l, config), nil
}

type timeoutError struct{}

func (timeoutError) Error() string   { return "tls: DialWithDialer timed out" }
func (timeoutError) Timeout() bool   { return true }
func (timeoutError) Temporary() bool { return true }

// DialWithDialer使用拨号器连接到给定的网络地址。拨号和
// 然后启动TLS握手，返回结果TLS连接。拨号程序中给出的任何
// 超时或截止日期均适用于连接和TLS 
// 握手。
// 
// DialWithDialer将零配置解释为等同于零
// 配置；有关默认设置，请参阅Config的文档。
// 
// DialWithDialer使用上下文。内部背景；要指定上下文，请使用拨号器。将NetDialer设置为所需拨号程序的DialContext。
func DialWithDialer(dialer *net.Dialer, network, addr string, config *Config) (*Conn, error) {
	return dial(context.Background(), dialer, network, addr, config)
}

func dial(ctx context.Context, netDialer *net.Dialer, network, addr string, config *Config) (*Conn, error) {
	if netDialer.Timeout != 0 {
		var cancel context.CancelFunc
		ctx, cancel = context.WithTimeout(ctx, netDialer.Timeout)
		defer cancel()
	}

	if !netDialer.Deadline.IsZero() {
		var cancel context.CancelFunc
		ctx, cancel = context.WithDeadline(ctx, netDialer.Deadline)
		defer cancel()
	}

	rawConn, err := netDialer.DialContext(ctx, network, addr)
	if err != nil {
		return nil, err
	}

	colonPos := strings.LastIndex(addr, ":")
	if colonPos == -1 {
		colonPos = len(addr)
	}
	hostname := addr[:colonPos]

	if config == nil {
		config = defaultConfig()
	}
	// 如果未设置服务器名，请根据我们连接到的主机名推断服务器名
	// 。
	if config.ServerName == "" {
		// 复制以避免污染参数或默认值。
		c := config.Clone()
		c.ServerName = hostname
		config = c
	}

	conn := Client(rawConn, config)
	if err := conn.HandshakeContext(ctx); err != nil {
		rawConn.Close()
		return nil, err
	}
	return conn, nil
}

// 拨号通过网络连接到给定的网络地址。拨打
// 然后启动TLS握手，返回结果
// TLS连接。
// 拨号将nil配置解释为等同于
// 零配置；有关默认设置，请参阅Config 
// 的文档。
func Dial(network, addr string, config *Config) (*Conn, error) {
	return DialWithDialer(new(net.Dialer), network, addr, config)
}

// 拨号程序拨号TLS连接给定
// 基础连接的配置和拨号程序。
type Dialer struct {
	// NetDialer是用于TLS连接的可选拨号程序
	// 底层TCP连接。
	// 零网络拨号器相当于网络。拨号零值。
	NetDialer *net.Dialer

	// Config是用于新连接的TLS配置。
	// 零配置相当于零
	// 配置；有关
	// 默认值，请参阅配置文档。
	Config *Config
}

// 拨号连接到给定的网络地址并启动TLS 
// 握手，返回结果TLS连接。
// 
// 返回的Conn（如果有）将始终为*Conn类型。
// 
// 拨号使用上下文。内部背景；要指定上下文，请使用DialContext。
func (d *Dialer) Dial(network, addr string) (net.Conn, error) {
	return d.DialContext(context.Background(), network, addr)
}

func (d *Dialer) netDialer() *net.Dialer {
	if d.NetDialer != nil {
		return d.NetDialer
	}
	return new(net.Dialer)
}

// DialContext连接到给定的网络地址并启动TLS 
// 握手，返回结果TLS连接。
// 
// 提供的上下文必须为非零。如果上下文在
// 连接完成之前过期，则返回错误。一旦
// 连接成功，上下文的任何过期都不会影响
// 连接。
// 
// 返回的Conn（如果有）将始终是*Conn类型。
func (d *Dialer) DialContext(ctx context.Context, network, addr string) (net.Conn, error) {
	c, err := dial(ctx, d.netDialer(), network, addr, d.Config)
	if err != nil {
		// 不要在接口中返回c（类型为nil）。
		return nil, err
	}
	return c, nil
}

// LoadX509KeyPair从一对
// 个文件。文件必须包含PEM编码的数据。证书文件
// 可能包含在
// 的叶证书之后的中间证书，形成一个证书链。成功返回后，请出示证书。Leaf将
// 为零，因为未保留证书的解析形式。
func LoadX509KeyPair(certFile, keyFile string) (Certificate, error) {
	certPEMBlock, err := os.ReadFile(certFile)
	if err != nil {
		return Certificate{}, err
	}
	keyPEMBlock, err := os.ReadFile(keyFile)
	if err != nil {
		return Certificate{}, err
	}
	return X509KeyPair(certPEMBlock, keyPEMBlock)
}

// X509KeyPair从一对
// PEM编码的数据中解析公钥/私钥对。成功返回后，请出示证书。由于
// 未保留证书的解析形式，Leaf将为零。
func X509KeyPair(certPEMBlock, keyPEMBlock []byte) (Certificate, error) {
	fail := func(err error) (Certificate, error) { return Certificate{}, err }

	var cert Certificate
	var skippedBlockTypes []string
	for {
		var certDERBlock *pem.Block
		certDERBlock, certPEMBlock = pem.Decode(certPEMBlock)
		if certDERBlock == nil {
			break
		}
		if certDERBlock.Type == "CERTIFICATE" {
			cert.Certificate = append(cert.Certificate, certDERBlock.Bytes)
		} else {
			skippedBlockTypes = append(skippedBlockTypes, certDERBlock.Type)
		}
	}

	if len(cert.Certificate) == 0 {
		if len(skippedBlockTypes) == 0 {
			return fail(errors.New("tls: failed to find any PEM data in certificate input"))
		}
		if len(skippedBlockTypes) == 1 && strings.HasSuffix(skippedBlockTypes[0], "PRIVATE KEY") {
			return fail(errors.New("tls: failed to find certificate PEM data in certificate input, but did find a private key; PEM inputs may have been switched"))
		}
		return fail(fmt.Errorf("tls: failed to find \"CERTIFICATE\" PEM block in certificate input after skipping PEM blocks of the following types: %v", skippedBlockTypes))
	}

	skippedBlockTypes = skippedBlockTypes[:0]
	var keyDERBlock *pem.Block
	for {
		keyDERBlock, keyPEMBlock = pem.Decode(keyPEMBlock)
		if keyDERBlock == nil {
			if len(skippedBlockTypes) == 0 {
				return fail(errors.New("tls: failed to find any PEM data in key input"))
			}
			if len(skippedBlockTypes) == 1 && skippedBlockTypes[0] == "CERTIFICATE" {
				return fail(errors.New("tls: found a certificate rather than a key in the PEM for the private key"))
			}
			return fail(fmt.Errorf("tls: failed to find PEM block with type ending in \"PRIVATE KEY\" in key input after skipping PEM blocks of the following types: %v", skippedBlockTypes))
		}
		if keyDERBlock.Type == "PRIVATE KEY" || strings.HasSuffix(keyDERBlock.Type, " PRIVATE KEY") {
			break
		}
		skippedBlockTypes = append(skippedBlockTypes, keyDERBlock.Type)
	}

	// 我们不需要解析TLS的公钥，但无论如何我们都需要解析，以检查它看起来是否正常并与私钥匹配。
	x509Cert, err := x509.ParseCertificate(cert.Certificate[0])
	if err != nil {
		return fail(err)
	}

	cert.PrivateKey, err = parsePrivateKey(keyDERBlock.Bytes)
	if err != nil {
		return fail(err)
	}

	switch pub := x509Cert.PublicKey.(type) {
	case *rsa.PublicKey:
		priv, ok := cert.PrivateKey.(*rsa.PrivateKey)
		if !ok {
			return fail(errors.New("tls: private key type does not match public key type"))
		}
		if pub.N.Cmp(priv.N) != 0 {
			return fail(errors.New("tls: private key does not match public key"))
		}
	case *ecdsa.PublicKey:
		priv, ok := cert.PrivateKey.(*ecdsa.PrivateKey)
		if !ok {
			return fail(errors.New("tls: private key type does not match public key type"))
		}
		if pub.X.Cmp(priv.X) != 0 || pub.Y.Cmp(priv.Y) != 0 {
			return fail(errors.New("tls: private key does not match public key"))
		}
	case ed25519.PublicKey:
		priv, ok := cert.PrivateKey.(ed25519.PrivateKey)
		if !ok {
			return fail(errors.New("tls: private key type does not match public key type"))
		}
		if !bytes.Equal(priv.Public().(ed25519.PublicKey), pub) {
			return fail(errors.New("tls: private key does not match public key"))
		}
	default:
		return fail(errors.New("tls: unknown public key algorithm"))
	}

	return cert, nil
}

// 尝试分析给定的私钥数据块。OpenSSL 0.9.8默认生成
// PKCS#1私钥，而OpenSSL 1.0.0生成PKCS#8私钥。
// OpenSSL ecparam为ECDSA生成SEC1 EC私钥。我们三个都试试。
func parsePrivateKey(der []byte) (crypto.PrivateKey, error) {
	if key, err := x509.ParsePKCS1PrivateKey(der); err == nil {
		return key, nil
	}
	if key, err := x509.ParsePKCS8PrivateKey(der); err == nil {
		switch key := key.(type) {
		case *rsa.PrivateKey, *ecdsa.PrivateKey, ed25519.PrivateKey:
			return key, nil
		default:
			return nil, errors.New("tls: found unknown private key type in PKCS#8 wrapping")
		}
	}
	if key, err := x509.ParseECPrivateKey(der); err == nil {
		return key, nil
	}

	return nil, errors.New("tls: failed to parse private key")
}
